Skip to main content
POST
/
api
/
v1
/
agent-configs
/
validate-key
Probe a candidate API key against Anthropic without persisting it. Used by the wizard path: the frontend validates a key before the user commits it. Always returns 200 — the `ProbeResult` body distinguishes valid from invalid.
curl --request POST \
  --url https://api.backside.app/api/v1/agent-configs/validate-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>"
}
'
{
  "status": "valid"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for POST /agent-configs/validate-key and PUT /agent-configs/{kind}/byok-key. Shared because both endpoints just take a raw provider API key.

​
api_key
string
required

Plaintext Anthropic API key. Transported over TLS + never logged.

Response

Probe result

Outcome of a single probe call. A probe is a write-time best-effort check, not a guarantee — a key that probes Valid can still be revoked before the next real request.

Serializes as an externally-tagged enum so the wire form is either {"status":"valid"} or {"status":"invalid","category":"...","message":"..."}.

​
status
enum<string>
required
Available options:
valid